<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
	<head>
		<title>UltraToolBar: LVToolBar Class</title>
		<link rel="stylesheet" href="LVStyle.css" type="text/css">
	</head>
	<body>
		<div class="Menu"><a href="../ToolBar.htm"><IMG alt="" src="Home.bmp" border="0"></a>&nbsp; 
			LogicalVue UltraToolBar Online Help&nbsp; (2.1.0)</div>
		<h1>LVToolBar Class</h1>
		<p></p>
		This class creates a ToolBar on your window. The ToolBar is anchored to the top 
		left corner of the window and will grow/shrink with the window as it is 
		resized.<p></p>
		<P>Parent Classes: Canvas: RectControl: Control: Object</P>
		<h2>Events</h2>
		<table>
			<tr>
				<td class="Name">Action(selectedToolBarItem As <a href="LVToolBarItem.htm">ToolBarItem</a>)</td>
				<td>
					A ToolBar button has been clicked. A right-click does not trigger the Action 
					event.&nbsp; This event is called from the MouseUp event.<BR>
					<BR>
					Check&nbsp;selectedToolBarItem.Caption or selectedToolBarItem.ItemID in the event to determine which button was 
					pressed.
				</td>
			</tr>
			<tr>
				<td class="Name">ActionMenu(selectedMenuItem As MenuItem)</td>
				<td>A menu on a ToolBar button with a menu has been clicked.  Check selectedMenuItem.Tag or selectedMenuItem.Text to
				determine which menu was selected.</td>
			</tr>
			<tr>
				<td class="Name">ToolBarChanged</td>
				<td>This event is fired when the toolbar style or its configuration has changed.</td>
			</tr>
		</table>
		<h2>Constants</h2>
		<table>
			<tr>
				<td class="Name">STYLE_BIG_ICONS_LABEL As Integer = 1</td>
				<td>Big icons (32x32) with a label underneath the icon.</td>
			</tr>
			<tr>
				<td class="Name">STYLE_SMALL_ICONS_LABEL As Integer = 2</td>
				<td>Small icons (16x16) with a label to the right of the icon.</td>
			</tr>
			<tr>
				<td class="Name">STYLE_BIG_ICONS As Integer = 3</td>
				<td>Big icons (32x32) with no label.</td>
			</tr>
			<tr>
				<td class="Name">STYLE_SMALL_ICONS As Integer = 4</td>
				<td>Small icons (16x16) with no label.</td>
			</tr>
			<tr>
				<td class="Name">STYLE_LABELS_ONLY As Integer = 5</td>
				<td>Labels only.</td>
			</tr>
		</table>
		<h2>Properties</h2>
		<table>
			<tr>
				<td class="Name">ToolBarStyle As Integer = SMALL_ICONS_LABEL</td>
				<td>
					Specifies the initial style for the ToolBar.&nbsp; Use the style contants 
					described above to set the&nbsp;style.</td>
			</tr>
			<tr>
				<td class="Name">StatusBar As <a href="LVStatusBar.htm">LVStatusBar</a></td>
				<td>Optionally associates an LVStatusBar to the ToolBar. The StatusBar is used to 
					display Caption and HelpTag information as the mouse moves over toolbar 
					buttons.</td>
			</tr>
			<tr>
				<td class="Name">AquaBackground As Boolean</td>
				<td>On Mac OS X, uses the striped Aqua background and dotted
				separators.</td>
			</tr>
			<tr>
				<td class="Name">Button(buttonNum As Integer)</td>
				<td>Allows you to get a specific button instance based on its position or to move a button to a new position.</td>
			</tr>
			<tr>
				<td class="Name">EnabledContextualMenu As Boolean</td>
				<td>Set to False to prevent the user from being able to right-click on the toolbar to customize it.  Defaults to True.</td>
			</tr>
		</table>
		<h2>Methods</h2>
		<table>
			<tr>
				<td class="Name">AddButton(myToolBarItem As <a href="LVToolBarItem.htm">LVToolBarItem</a>)</td>
				<td>Adds a ToolBarItem as a button to the ToolBar.</td>
			</tr>
			<tr>
				<td class="Name">Redraw(eraseBackground As Boolean = True)</td>
				<td>Redraws the toolbar.</td>
			</tr>
			<tr>
				<td class="Name">Register(regCode As String, userName As String)</td>
				<td>Registers the toolbar for use in compiled applications.</td>
			</tr>
			<tr>
				<td class="Name">Version As String</td>
				<td>Returns the current UltraToolBar version.</td>
			</tr>
			<tr>
				<td class="Name">Customize</td>
				<td>Opens the Customization window.</td>
			</tr>
			<tr>
				<td class="Name">ShowHide</td>
				<td>Toggles between showing and hiding toolbar.</td>
			</tr>
			<tr>
				<td class="Name">LockControl(myControl As RectControl)</td>
				<td>Prevents the specified control from being moved when the toolbar size changes.</td>
			</tr>
			<tr>
				<td class="Name">ButtonCount As Integer</td>
				<td>Returns the number of buttons (ToolBarItems) in the toolbar.</td>
			</tr>
		</table>
		<h2>Notes</h2>
		<p>The toolbar knows which OS it is running on and styles itself accordingly.</p>
		<P>A window should have only one ToolBar.</P>
		<P>Right-clicking on the ToolBar displays a context menu that allows the user to 
			alter the ToolBar's display style or to open the Customization window.</P>
			<p>On Mac OS X, CarbonEvents are used to process the ToolBarButton in the TitleBar.  This uses the LVSystem module.</p>
		<p class="Small">Copyright 2006 <a href="http://www.logicalvue.com">LogicalVue 
				Software, Inc.</a></p>
	</body>
</html>
<i></i>